/*
 * Copyright 2002-present the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.graphql.server.support;

import java.util.Map;

import reactor.core.publisher.Mono;

import org.springframework.security.core.Authentication;

/**
 * Strategy to extract an {@link Authentication} from the payload of a
 * {@code "connection_init"} GraphQL over WebSocket message.
 *
 * @author Joshua Cummings
 * @author Rossen Stoyanchev
 * @since 1.3.0
 */
public interface AuthenticationExtractor {

	/**
	 * Return the authentication contained in the given payload, or an empty {@code Mono}.
	 * @param payload the payload to extract the authentication value from
	 */
	Mono<Authentication> getAuthentication(Map<String, Object> payload);

}
